home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1998 January / Macworld (1998-01).dmg / Shareware World / Comms & Internet / quickest-mirror-1.1 / Scripting / DocServer Source Text next >
Text File  |  1997-10-31  |  4KB  |  92 lines
  1.  
  2. Verb    QuickestMirror.bringToFront
  3. Syntax    QuickestMirror.bringToFront ()
  4. Parameters    None required.
  5. Action    Makes QuickestMirror the frontmost application.
  6. Returns    True
  7. Examples    QuickestMirror.bringToFront ()
  8.     » true
  9. Notes    You don’t often need to use this verb in conjunction with the other QuickestMirror verbs. Those that should or must bring QuickestMirror to the front do so automatically.
  10. See Also    sys.bringAppToFront
  11. QuickestMirror.launch
  12. QuickestMirror.quit
  13.  
  14. Verb    QuickestMirror.fetchurl
  15. Syntax    theList = QuickestMirror.fetchurl (s)
  16. Parameters    s is the URL specification in the form "fab://[user[:password]@]host[:port][/url-path]?[object-path]"
  17. [brackets] indicate optional arguments
  18. For more info, see http://www.kagi.com/authors/fab/faburlscheme.html
  19. Some commonly used pseudo-URLs are accepted
  20. Action    Maps the fab URL to its corresponding set of URLs.
  21. Returns    A list of URLs corresponding to the original fab URL.
  22. Examples    QuickestMirror.fetchurl ("fab://devworld.apple.com?")
  23.     » {"http://devworld.apple.com/", "http://devworld.euro.apple.com/"}
  24. Notes    • fetchurl automatically performs the normalizeurl step.
  25. See Also    QuickestMirror.geturl
  26. QuickestMirror.normalizeurl
  27.  
  28. Verb    QuickestMirror.geturl
  29. Syntax    QuickestMirror.geturl (s)
  30. Parameters    s is the URL specification in the form "fab://[user[:password]@]host[:port][/url-path]?[object-path]"
  31. [brackets] indicate optional arguments
  32. For more info, see http://www.kagi.com/authors/fab/faburlscheme.html
  33. Some commonly used pseudo-URLs are accepted
  34. Action    Maps the fab URL to its corresponding set of URLs, and displays them as a dynamically sorted list so that the faster sites drift toward the top.
  35. The list is static if OpenTransport is not available or the Macintosh is not connected to the Internet.
  36. Returns    True if request succeeds, false otherwise.
  37. Examples    QuickestMirror.geturl ("fab://info-mac.org?")
  38.     » true
  39. Notes    • To use the geturl event, first make sure to register QuickestMirror as a helper for the fab protocol with InternetConfig.
  40. • geturl automatically performs the normalizeurl step.
  41. See Also    QuickestMirror.fetchurl
  42. QuickestMirror.normalizeurl
  43.  
  44. Verb    QuickestMirror.isRunning
  45. Syntax    QuickestMirror.isRunning ()
  46. Parameters    None.
  47. Action    Checks if QuickestMirror is running.
  48. Returns    True if QuickestMirror is running, false if it is not.
  49. Examples    QuickestMirror.isRunning ()
  50.     » true
  51. See Also    QuickestMirror.launch
  52. QuickestMirror.quit
  53.  
  54. Verb    QuickestMirror.launch
  55. Syntax    QuickestMirror.launch ()
  56. Parameters    None.
  57. Action    Launches QuickestMirror.
  58. Returns    True if request succeeds, false otherwise.
  59. Examples    QuickestMirror.launch ()
  60.     » true
  61. See Also    QuickestMirror.quit
  62.  
  63. Verb    QuickestMirror.normalizeurl
  64. Syntax    n = QuickestMirror.normalizeurl (s)
  65. Parameters    s is the URL specification in the form "fab://[user[:password]@]host[:port][/url-path]?[object-path]"
  66. [brackets] indicate optional arguments
  67. For more info, see http://www.kagi.com/authors/fab/faburlscheme.html
  68. Some commonly used pseudo-URLs are accepted
  69. Action    Converts the input string to a canonical fab URL.
  70. Returns    A canonical fab URL, an error if the string couldn’t be normalized.
  71. Examples    QuickestMirror.normalizeurl ("[Archived as /info-mac/cfg/y-not.hqx; 6K]")
  72.     » "fab://info-mac.org?cfg/y-not.hqx"
  73. See Also    QuickestMirror.fetchurl
  74. QuickestMirror.geturl
  75.  
  76. Verb    QuickestMirror.openDocument
  77. Syntax    QuickestMirror.openDocument (path)
  78. Parameters    path is the path name of a file you wish to open.  Typically a Netscape or MS Explorer link.
  79. Action    The same effect as dragging an item onto the QuickestMirror icon.
  80. Returns    True if successful, an error otherwise.
  81. Examples    QuickestMirror.openDocument ("HD:Links:fab link")
  82. See Also    QuickestMirror.launch
  83.  
  84. Verb    QuickestMirror.quit
  85. Syntax    QuickestMirror.quit ()
  86. Parameters    None.
  87. Action    Quits QuickestMirror.
  88. Returns    True if the request is successful, false otherwise.
  89. Examples    QuickestMirror.quit ()
  90.     » true
  91. See Also    QuickestMirror.launch
  92.